/*******************************************************************************
 * Software Name : RCS IMS Stack
 *
 * Copyright (C) 2010-2016 Orange.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/

package com.gsma.rcs.core.ims.service.presence;

/**
 * Presence info
 * 
 * @author Jean-Marc AUFFRET
 */
public class PresenceInfo {
    /**
     * Presence status "unknown"
     */
    public final static String UNKNOWN = "unknown";

    /**
     * Presence status "online"
     */
    public final static String ONLINE = "open";

    /**
     * Presence status "offline"
     */
    public final static String OFFLINE = "closed";

    /**
     * Presence relationship: contact 'rcs granted' with the user
     */
    public final static String RCS_ACTIVE = "active";

    /**
     * Presence relationship: the user has revoked the contact
     */
    public final static String RCS_REVOKED = "revoked";

    /**
     * Presence relationship: the user has blocked the contact
     */
    public final static String RCS_BLOCKED = "blocked";

    /**
     * Presence relationship: the user has sent an invitation to the contact without response for
     * now
     */
    public final static String RCS_PENDING_OUT = "pending_out";

    /**
     * Presence relationship: the contact has sent an invitation to the user without response for
     * now
     */
    public final static String RCS_PENDING = "pending";

    /**
     * Presence relationship: the contact has sent an invitation to the user and cancel it
     */
    public final static String RCS_CANCELLED = "cancelled";

    /**
     * Presence timestamp
     */
    private long timestamp = System.currentTimeMillis();

    /**
     * Presence status
     */
    private String status = PresenceInfo.ONLINE;

    /**
     * Free text
     */
    private String freetext = null;

    /**
     * Favorite link
     */
    private FavoriteLink favoriteLink = null;

    /**
     * Photo icon
     */
    private PhotoIcon photo = null;

    /**
     * Geoloc
     */
    private Geoloc geoloc = null;

    /**
     * Constructor
     */
    public PresenceInfo() {
    }

    /**
     * Set the timestamp
     * 
     * @param timestamp Timestamp
     */
    public void setTimestamp(long timestamp) {
        this.timestamp = timestamp;
    }

    /**
     * Returns the timestamp
     * 
     * @return Timestamp
     */
    public long getTimestamp() {
        return timestamp;
    }

    /**
     * Reset the timestamp
     */
    public void resetTimestamp() {
        timestamp = PresenceInfo.getNewTimestamp();
    }

    /**
     * Returns a new timestamp
     * 
     * @return Timestamp
     */
    public static long getNewTimestamp() {
        return System.currentTimeMillis();
    }

    /**
     * Returns the presence status
     * 
     * @return Status
     */
    public String getPresenceStatus() {
        return status;
    }

    /**
     * Set the presence status
     * 
     * @param status New status
     */
    public void setPresenceStatus(String status) {
        this.status = status;
    }

    /**
     * Is status online
     * 
     * @return Boolean
     */
    public boolean isOnline() {
        return (ONLINE.equals(status));
    }

    /**
     * Is status offline
     * 
     * @return Boolean
     */
    public boolean isOffline() {
        return (OFFLINE.equals(status));
    }

    /**
     * Returns the free text
     * 
     * @return Free text
     */
    public String getFreetext() {
        return freetext;
    }

    /**
     * Set the free text
     * 
     * @param freetext New free text
     */
    public void setFreetext(String freetext) {
        this.freetext = freetext;
    }

    /**
     * Get the favorite link
     * 
     * @return Favorite link
     */
    public FavoriteLink getFavoriteLink() {
        return favoriteLink;
    }

    /**
     * Get the favorite link URL
     * 
     * @return Favorite link URL
     */
    public String getFavoriteLinkUrl() {
        String url = null;
        if (favoriteLink != null) {
            url = favoriteLink.getLink();
        }
        return url;
    }

    /**
     * Set the favorite link
     * 
     * @param favoriteLink Favorite link
     */
    public void setFavoriteLink(FavoriteLink favoriteLink) {
        this.favoriteLink = favoriteLink;
    }

    /**
     * Set the favorite link URL
     * 
     * @param url Favorite link URL
     */
    public void setFavoriteLinkUrl(String url) {
        if (favoriteLink == null) {
            favoriteLink = new FavoriteLink(url);
        }
        favoriteLink.setLink(url);
    }

    /**
     * Get the photo-icon
     */
    public PhotoIcon getPhotoIcon() {
        return photo;
    }

    /**
     * Set the photo-icon
     * 
     * @param photo Photo-icon
     */
    public void setPhotoIcon(PhotoIcon photo) {
        this.photo = photo;
    }

    /**
     * Get the geoloc
     * 
     * @return Geoloc
     */
    public Geoloc getGeoloc() {
        return geoloc;
    }

    /**
     * Set the geoloc
     * 
     * @param geoloc Geoloc
     */
    public void setGeoloc(Geoloc geoloc) {
        this.geoloc = geoloc;
    }

    /**
     * Returns a string representation of the object
     * 
     * @return String
     */
    public String toString() {
        String result = "- Timestamp: " + timestamp + "\n" + "- Status: " + status + "\n"
                + "- Freetext: " + freetext + "\n";
        if (favoriteLink != null) {
            result += "- Favorite link: " + favoriteLink.toString() + "\n";
        }
        if (photo != null) {
            result += "- Photo-icon: " + photo.toString() + "\n";
        }
        if (geoloc != null) {
            result += "- Geoloc: " + geoloc.toString() + "\n";
        }
        return result;
    }
}
